Embedded SDK/com.beyondidentity.embedded.sdk.models

Package-level declarations

Types

data class AuthenticateResponse(val redirectUrl: String, val message: String? = null, var passkeyBindingToken: String? = null)

A response returned after successfully authenticating.

AuthenticationContext

data class AuthenticationContext(val authUrl: String, val application: AuthenticationContext.Application, val origin: AuthenticationContext.Origin)

Information associated with the current authentication request returned from getAuthenticationContext.

BindPasskeyResponse

data class BindPasskeyResponse(val passkey: Passkey, val postBindingRedirectUri: String? = null)

A response returned after successfully binding a passkey to a device.

Identity

data class Identity(val id: IdentityId, val displayName: String, val username: String, val primaryEmailAddress: String?)

Identity information associated with a Passkey. An Identity is a unique identifier that may be used by an end-user to gain access governed by Beyond Identity. An Identity is created at the Realm level. An end-user may have multiple identities. A Realm can have many Identities.

IdentityId

typealias IdentityId = String

The The unique identifier of the Identity.

KeyHandle

typealias KeyHandle = String

Associated key handle.

OnSelectedPasskey

typealias OnSelectedPasskey = (PasskeyId?) -> Unit

OnSelectPasskey

typealias OnSelectPasskey = (List<Passkey>, OnSelectedPasskey) -> Unit

OtpChallengeResponse

data class OtpChallengeResponse(val url: String)

A response returned if the SDK requires an OTP.

Passkey

data class Passkey(val id: PasskeyId, val localCreated: String, val localUpdated: String, val apiBaseUrl: String, val keyHandle: KeyHandle, val state: State, val created: String, val updated: String, val tenant: Tenant, val realm: Realm, val identity: Identity, val theme: Theme)

A Universal Passkey is a public and private key pair. The private key is generated, stored, and never leaves the user’s devices’ hardware root of trust (i.e. Secure Enclave). The public key is sent to the Beyond Identity cloud. The private key cannot be tampered with, viewed, or removed from the device in which it is created unless the user explicitly indicates that the trusted device be removed. Passkeys are cryptographically linked to devices and an Identity. A single device can store multiple passkeys for different users and a single Identity can have multiple passkeys.

PasskeyId

typealias PasskeyId = String

The Globally unique ID of a passkey.

Realm

data class Realm(val id: RealmId, val displayName: String)

Realm information associated with a Passkey. A Realm is a unique administrative domain within a Tenant. Some Tenants will only need the use of a single Realm, in this case a Realm and a Tenant may seem synonymous. Each Realm contains a unique set of Directory, Policy, Event, Application, and Branding objects.

RealmId

typealias RealmId = String

The The unique identifier of the Realm.

RedeemOtpResponse

sealed class RedeemOtpResponse

A response returned after successfully authenticating.

State

enum State : Enum<State>

State of a given Passkey.

Tenant

data class Tenant(val id: TenantId, val displayName: String)

Tenant information associated with a Passkey. A Tenant represents an organization in the Beyond Identity Cloud and serves as a root container for all other cloud components in your configuration.

TenantId

typealias TenantId = String

The The unique identifier of the Tenant.

Theme

data class Theme(val logoLightUrl: String, val logoDarkUrl: String, val supportUrl: String)

Theme associated with a Passkey.